<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *   http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> *<a name="line.16"></a>
<span class="sourceLineNo">017</span> */<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.commons.net.util;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.File;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.io.FileInputStream;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.io.IOException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.net.Socket;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.security.GeneralSecurityException;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.security.KeyStore;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.security.KeyStoreException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.security.Principal;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.security.PrivateKey;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.security.cert.Certificate;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.security.cert.X509Certificate;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.Enumeration;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>import javax.net.ssl.KeyManager;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import javax.net.ssl.X509ExtendedKeyManager;<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.commons.net.io.Util;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>/**<a name="line.39"></a>
<span class="sourceLineNo">040</span> * General KeyManager utilities<a name="line.40"></a>
<span class="sourceLineNo">041</span> * &lt;p&gt;<a name="line.41"></a>
<span class="sourceLineNo">042</span> * How to use with a client certificate:<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;pre&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> * KeyManager km = KeyManagerUtils.createClientKeyManager("JKS",<a name="line.44"></a>
<span class="sourceLineNo">045</span> *     "/path/to/privatekeystore.jks","storepassword",<a name="line.45"></a>
<span class="sourceLineNo">046</span> *     "privatekeyalias", "keypassword");<a name="line.46"></a>
<span class="sourceLineNo">047</span> * FTPSClient cl = new FTPSClient();<a name="line.47"></a>
<span class="sourceLineNo">048</span> * cl.setKeyManager(km);<a name="line.48"></a>
<span class="sourceLineNo">049</span> * cl.connect(...);<a name="line.49"></a>
<span class="sourceLineNo">050</span> * &lt;/pre&gt;<a name="line.50"></a>
<span class="sourceLineNo">051</span> * If using the default store type and the key password is the same as the<a name="line.51"></a>
<span class="sourceLineNo">052</span> * store password, these parameters can be omitted. &lt;br/&gt;<a name="line.52"></a>
<span class="sourceLineNo">053</span> * If the desired key is the first or only key in the keystore, the keyAlias parameter<a name="line.53"></a>
<span class="sourceLineNo">054</span> * can be omitted, in which case the code becomes:<a name="line.54"></a>
<span class="sourceLineNo">055</span> * &lt;pre&gt;<a name="line.55"></a>
<span class="sourceLineNo">056</span> * KeyManager km = KeyManagerUtils.createClientKeyManager(<a name="line.56"></a>
<span class="sourceLineNo">057</span> *     "/path/to/privatekeystore.jks","storepassword");<a name="line.57"></a>
<span class="sourceLineNo">058</span> * FTPSClient cl = new FTPSClient();<a name="line.58"></a>
<span class="sourceLineNo">059</span> * cl.setKeyManager(km);<a name="line.59"></a>
<span class="sourceLineNo">060</span> * cl.connect(...);<a name="line.60"></a>
<span class="sourceLineNo">061</span> * &lt;/pre&gt;<a name="line.61"></a>
<span class="sourceLineNo">062</span> *<a name="line.62"></a>
<span class="sourceLineNo">063</span> * @since 3.0<a name="line.63"></a>
<span class="sourceLineNo">064</span> */<a name="line.64"></a>
<span class="sourceLineNo">065</span>public final class KeyManagerUtils {<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span>    private static final String DEFAULT_STORE_TYPE = KeyStore.getDefaultType();<a name="line.67"></a>
<span class="sourceLineNo">068</span><a name="line.68"></a>
<span class="sourceLineNo">069</span>    private KeyManagerUtils(){<a name="line.69"></a>
<span class="sourceLineNo">070</span>        // Not instantiable<a name="line.70"></a>
<span class="sourceLineNo">071</span>    }<a name="line.71"></a>
<span class="sourceLineNo">072</span><a name="line.72"></a>
<span class="sourceLineNo">073</span>    /**<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * Create a client key manager which returns a particular key.<a name="line.74"></a>
<span class="sourceLineNo">075</span>     * Does not handle server keys.<a name="line.75"></a>
<span class="sourceLineNo">076</span>     *<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * @param ks the keystore to use<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * @param keyAlias the alias of the key to use, may be {@code null} in which case the first key entry alias is used<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * @param keyPass the password of the key to use<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @return the customised KeyManager<a name="line.80"></a>
<span class="sourceLineNo">081</span>     */<a name="line.81"></a>
<span class="sourceLineNo">082</span>    public static KeyManager createClientKeyManager(KeyStore ks, String keyAlias, String keyPass)<a name="line.82"></a>
<span class="sourceLineNo">083</span>        throws GeneralSecurityException<a name="line.83"></a>
<span class="sourceLineNo">084</span>    {<a name="line.84"></a>
<span class="sourceLineNo">085</span>        ClientKeyStore cks = new ClientKeyStore(ks, keyAlias != null ? keyAlias : findAlias(ks), keyPass);<a name="line.85"></a>
<span class="sourceLineNo">086</span>        return new X509KeyManager(cks);<a name="line.86"></a>
<span class="sourceLineNo">087</span>    }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Create a client key manager which returns a particular key.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * Does not handle server keys.<a name="line.91"></a>
<span class="sourceLineNo">092</span>     *<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * @param storeType the type of the keyStore, e.g. "JKS"<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * @param storePath the path to the keyStore<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * @param storePass the keyStore password<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * @param keyAlias the alias of the key to use, may be {@code null} in which case the first key entry alias is used<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * @param keyPass the password of the key to use<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * @return the customised KeyManager<a name="line.98"></a>
<span class="sourceLineNo">099</span>     */<a name="line.99"></a>
<span class="sourceLineNo">100</span>    public static KeyManager createClientKeyManager(String storeType, File storePath, String storePass, String keyAlias, String keyPass)<a name="line.100"></a>
<span class="sourceLineNo">101</span>        throws IOException, GeneralSecurityException<a name="line.101"></a>
<span class="sourceLineNo">102</span>    {<a name="line.102"></a>
<span class="sourceLineNo">103</span>        KeyStore ks = loadStore(storeType, storePath, storePass);<a name="line.103"></a>
<span class="sourceLineNo">104</span>        return createClientKeyManager(ks, keyAlias, keyPass);<a name="line.104"></a>
<span class="sourceLineNo">105</span>    }<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>
<span class="sourceLineNo">107</span>    /**<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * Create a client key manager which returns a particular key.<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * Does not handle server keys.<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * Uses the default store type and assumes the key password is the same as the store password<a name="line.110"></a>
<span class="sourceLineNo">111</span>     *<a name="line.111"></a>
<span class="sourceLineNo">112</span>     * @param storePath the path to the keyStore<a name="line.112"></a>
<span class="sourceLineNo">113</span>     * @param storePass the keyStore password<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * @param keyAlias the alias of the key to use, may be {@code null} in which case the first key entry alias is used<a name="line.114"></a>
<span class="sourceLineNo">115</span>     * @return the customised KeyManager<a name="line.115"></a>
<span class="sourceLineNo">116</span>     */<a name="line.116"></a>
<span class="sourceLineNo">117</span>    public static KeyManager createClientKeyManager(File storePath, String storePass, String keyAlias)<a name="line.117"></a>
<span class="sourceLineNo">118</span>        throws IOException, GeneralSecurityException<a name="line.118"></a>
<span class="sourceLineNo">119</span>    {<a name="line.119"></a>
<span class="sourceLineNo">120</span>        return createClientKeyManager(DEFAULT_STORE_TYPE, storePath, storePass, keyAlias, storePass);<a name="line.120"></a>
<span class="sourceLineNo">121</span>    }<a name="line.121"></a>
<span class="sourceLineNo">122</span><a name="line.122"></a>
<span class="sourceLineNo">123</span>    /**<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * Create a client key manager which returns a particular key.<a name="line.124"></a>
<span class="sourceLineNo">125</span>     * Does not handle server keys.<a name="line.125"></a>
<span class="sourceLineNo">126</span>     * Uses the default store type and assumes the key password is the same as the store password.<a name="line.126"></a>
<span class="sourceLineNo">127</span>     * The key alias is found by searching the keystore for the first private key entry<a name="line.127"></a>
<span class="sourceLineNo">128</span>     *<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * @param storePath the path to the keyStore<a name="line.129"></a>
<span class="sourceLineNo">130</span>     * @param storePass the keyStore password<a name="line.130"></a>
<span class="sourceLineNo">131</span>     * @return the customised KeyManager<a name="line.131"></a>
<span class="sourceLineNo">132</span>     */<a name="line.132"></a>
<span class="sourceLineNo">133</span>    public static KeyManager createClientKeyManager(File storePath, String storePass)<a name="line.133"></a>
<span class="sourceLineNo">134</span>        throws IOException, GeneralSecurityException<a name="line.134"></a>
<span class="sourceLineNo">135</span>    {<a name="line.135"></a>
<span class="sourceLineNo">136</span>        return createClientKeyManager(DEFAULT_STORE_TYPE, storePath, storePass, null, storePass);<a name="line.136"></a>
<span class="sourceLineNo">137</span>    }<a name="line.137"></a>
<span class="sourceLineNo">138</span><a name="line.138"></a>
<span class="sourceLineNo">139</span>    private static KeyStore loadStore(String storeType, File storePath, String storePass)<a name="line.139"></a>
<span class="sourceLineNo">140</span>        throws KeyStoreException,  IOException, GeneralSecurityException {<a name="line.140"></a>
<span class="sourceLineNo">141</span>        KeyStore ks = KeyStore.getInstance(storeType);<a name="line.141"></a>
<span class="sourceLineNo">142</span>        FileInputStream stream = null;<a name="line.142"></a>
<span class="sourceLineNo">143</span>        try {<a name="line.143"></a>
<span class="sourceLineNo">144</span>            stream = new FileInputStream(storePath);<a name="line.144"></a>
<span class="sourceLineNo">145</span>            ks.load(stream, storePass.toCharArray());<a name="line.145"></a>
<span class="sourceLineNo">146</span>        } finally {<a name="line.146"></a>
<span class="sourceLineNo">147</span>            Util.closeQuietly(stream);<a name="line.147"></a>
<span class="sourceLineNo">148</span>        }<a name="line.148"></a>
<span class="sourceLineNo">149</span>        return ks;<a name="line.149"></a>
<span class="sourceLineNo">150</span>    }<a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span>    private static String findAlias(KeyStore ks) throws KeyStoreException {<a name="line.152"></a>
<span class="sourceLineNo">153</span>        Enumeration&lt;String&gt; e = ks.aliases();<a name="line.153"></a>
<span class="sourceLineNo">154</span>        while(e.hasMoreElements()) {<a name="line.154"></a>
<span class="sourceLineNo">155</span>            String entry = e.nextElement();<a name="line.155"></a>
<span class="sourceLineNo">156</span>            if (ks.isKeyEntry(entry)) {<a name="line.156"></a>
<span class="sourceLineNo">157</span>                return entry;<a name="line.157"></a>
<span class="sourceLineNo">158</span>            }<a name="line.158"></a>
<span class="sourceLineNo">159</span>        }<a name="line.159"></a>
<span class="sourceLineNo">160</span>        throw new KeyStoreException("Cannot find a private key entry");<a name="line.160"></a>
<span class="sourceLineNo">161</span>    }<a name="line.161"></a>
<span class="sourceLineNo">162</span><a name="line.162"></a>
<span class="sourceLineNo">163</span>    private static class ClientKeyStore {<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span>        private final X509Certificate[] certChain;<a name="line.165"></a>
<span class="sourceLineNo">166</span>        private final PrivateKey key;<a name="line.166"></a>
<span class="sourceLineNo">167</span>        private final String keyAlias;<a name="line.167"></a>
<span class="sourceLineNo">168</span><a name="line.168"></a>
<span class="sourceLineNo">169</span>        ClientKeyStore(KeyStore ks, String keyAlias, String keyPass) throws GeneralSecurityException<a name="line.169"></a>
<span class="sourceLineNo">170</span>        {<a name="line.170"></a>
<span class="sourceLineNo">171</span>            this.keyAlias = keyAlias;<a name="line.171"></a>
<span class="sourceLineNo">172</span>            this.key = (PrivateKey) ks.getKey(this.keyAlias, keyPass.toCharArray());<a name="line.172"></a>
<span class="sourceLineNo">173</span>            Certificate[] certs = ks.getCertificateChain(this.keyAlias);<a name="line.173"></a>
<span class="sourceLineNo">174</span>            X509Certificate[] X509certs = new X509Certificate[certs.length];<a name="line.174"></a>
<span class="sourceLineNo">175</span>            for (int i=0; i &lt; certs.length; i++) {<a name="line.175"></a>
<span class="sourceLineNo">176</span>                X509certs[i] = (X509Certificate) certs[i];<a name="line.176"></a>
<span class="sourceLineNo">177</span>            }<a name="line.177"></a>
<span class="sourceLineNo">178</span>            this.certChain = X509certs;<a name="line.178"></a>
<span class="sourceLineNo">179</span>        }<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>
<span class="sourceLineNo">181</span>        final X509Certificate[] getCertificateChain() {<a name="line.181"></a>
<span class="sourceLineNo">182</span>            return this.certChain;<a name="line.182"></a>
<span class="sourceLineNo">183</span>        }<a name="line.183"></a>
<span class="sourceLineNo">184</span><a name="line.184"></a>
<span class="sourceLineNo">185</span>        final PrivateKey getPrivateKey() {<a name="line.185"></a>
<span class="sourceLineNo">186</span>            return this.key;<a name="line.186"></a>
<span class="sourceLineNo">187</span>        }<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span>        final String getAlias() {<a name="line.189"></a>
<span class="sourceLineNo">190</span>            return this.keyAlias;<a name="line.190"></a>
<span class="sourceLineNo">191</span>        }<a name="line.191"></a>
<span class="sourceLineNo">192</span>    }<a name="line.192"></a>
<span class="sourceLineNo">193</span><a name="line.193"></a>
<span class="sourceLineNo">194</span>    private static class X509KeyManager extends X509ExtendedKeyManager  {<a name="line.194"></a>
<span class="sourceLineNo">195</span><a name="line.195"></a>
<span class="sourceLineNo">196</span>        private final ClientKeyStore keyStore;<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span>        X509KeyManager(final ClientKeyStore keyStore) {<a name="line.198"></a>
<span class="sourceLineNo">199</span>            this.keyStore = keyStore;<a name="line.199"></a>
<span class="sourceLineNo">200</span>        }<a name="line.200"></a>
<span class="sourceLineNo">201</span><a name="line.201"></a>
<span class="sourceLineNo">202</span>        // Call sequence: 1<a name="line.202"></a>
<span class="sourceLineNo">203</span>//        @Override<a name="line.203"></a>
<span class="sourceLineNo">204</span>        public String chooseClientAlias(String[] keyType, Principal[] issuers,<a name="line.204"></a>
<span class="sourceLineNo">205</span>                Socket socket) {<a name="line.205"></a>
<span class="sourceLineNo">206</span>            return keyStore.getAlias();<a name="line.206"></a>
<span class="sourceLineNo">207</span>        }<a name="line.207"></a>
<span class="sourceLineNo">208</span><a name="line.208"></a>
<span class="sourceLineNo">209</span>        // Call sequence: 2<a name="line.209"></a>
<span class="sourceLineNo">210</span>//        @Override<a name="line.210"></a>
<span class="sourceLineNo">211</span>        public X509Certificate[] getCertificateChain(String alias) {<a name="line.211"></a>
<span class="sourceLineNo">212</span>            return keyStore.getCertificateChain();<a name="line.212"></a>
<span class="sourceLineNo">213</span>        }<a name="line.213"></a>
<span class="sourceLineNo">214</span><a name="line.214"></a>
<span class="sourceLineNo">215</span>//        @Override<a name="line.215"></a>
<span class="sourceLineNo">216</span>        public String[] getClientAliases(String keyType, Principal[] issuers) {<a name="line.216"></a>
<span class="sourceLineNo">217</span>            return new String[]{ keyStore.getAlias()};<a name="line.217"></a>
<span class="sourceLineNo">218</span>        }<a name="line.218"></a>
<span class="sourceLineNo">219</span><a name="line.219"></a>
<span class="sourceLineNo">220</span>        // Call sequence: 3<a name="line.220"></a>
<span class="sourceLineNo">221</span>//        @Override<a name="line.221"></a>
<span class="sourceLineNo">222</span>        public PrivateKey getPrivateKey(String alias) {<a name="line.222"></a>
<span class="sourceLineNo">223</span>            return keyStore.getPrivateKey();<a name="line.223"></a>
<span class="sourceLineNo">224</span>        }<a name="line.224"></a>
<span class="sourceLineNo">225</span><a name="line.225"></a>
<span class="sourceLineNo">226</span>//        @Override<a name="line.226"></a>
<span class="sourceLineNo">227</span>        public String[] getServerAliases(String keyType, Principal[] issuers) {<a name="line.227"></a>
<span class="sourceLineNo">228</span>            return null;<a name="line.228"></a>
<span class="sourceLineNo">229</span>        }<a name="line.229"></a>
<span class="sourceLineNo">230</span><a name="line.230"></a>
<span class="sourceLineNo">231</span>//        @Override<a name="line.231"></a>
<span class="sourceLineNo">232</span>        public String chooseServerAlias(String keyType, Principal[] issuers, Socket socket) {<a name="line.232"></a>
<span class="sourceLineNo">233</span>            return null;<a name="line.233"></a>
<span class="sourceLineNo">234</span>        }<a name="line.234"></a>
<span class="sourceLineNo">235</span><a name="line.235"></a>
<span class="sourceLineNo">236</span>    }<a name="line.236"></a>
<span class="sourceLineNo">237</span><a name="line.237"></a>
<span class="sourceLineNo">238</span>}<a name="line.238"></a>




























































</pre>
</div>
</body>
</html>
